<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.commons.net.pop3;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.security.InvalidKeyException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.security.NoSuchAlgorithmException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.security.spec.InvalidKeySpecException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import javax.crypto.Mac;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import javax.crypto.spec.SecretKeySpec;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.commons.net.util.Base64;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>/**<a name="line.30"></a>
<span class="sourceLineNo">031</span> * A POP3 Cilent class with protocol and authentication extensions support<a name="line.31"></a>
<span class="sourceLineNo">032</span> * (RFC2449 and RFC2195).<a name="line.32"></a>
<span class="sourceLineNo">033</span> * @see POP3Client<a name="line.33"></a>
<span class="sourceLineNo">034</span> * @since 3.0<a name="line.34"></a>
<span class="sourceLineNo">035</span> */<a name="line.35"></a>
<span class="sourceLineNo">036</span>public class ExtendedPOP3Client extends POP3SClient<a name="line.36"></a>
<span class="sourceLineNo">037</span>{<a name="line.37"></a>
<span class="sourceLineNo">038</span>    /**<a name="line.38"></a>
<span class="sourceLineNo">039</span>     * The default ExtendedPOP3Client constructor.<a name="line.39"></a>
<span class="sourceLineNo">040</span>     * Creates a new Extended POP3 Client.<a name="line.40"></a>
<span class="sourceLineNo">041</span>     * @throws NoSuchAlgorithmException<a name="line.41"></a>
<span class="sourceLineNo">042</span>     */<a name="line.42"></a>
<span class="sourceLineNo">043</span>    public ExtendedPOP3Client() throws NoSuchAlgorithmException<a name="line.43"></a>
<span class="sourceLineNo">044</span>    {<a name="line.44"></a>
<span class="sourceLineNo">045</span>        super();<a name="line.45"></a>
<span class="sourceLineNo">046</span>    }<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span>    /***<a name="line.48"></a>
<span class="sourceLineNo">049</span>     * Authenticate to the POP3 server by sending the AUTH command with the<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * selected mechanism, using the given username and the given password.<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * &lt;p&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span>     * @param method the {@link AUTH_METHOD} to use<a name="line.52"></a>
<span class="sourceLineNo">053</span>     * @param username the user name<a name="line.53"></a>
<span class="sourceLineNo">054</span>     * @param password the password<a name="line.54"></a>
<span class="sourceLineNo">055</span>     * @return True if successfully completed, false if not.<a name="line.55"></a>
<span class="sourceLineNo">056</span>     * @exception IOException  If an I/O error occurs while either sending a<a name="line.56"></a>
<span class="sourceLineNo">057</span>     *      command to the server or receiving a reply from the server.<a name="line.57"></a>
<span class="sourceLineNo">058</span>     * @exception NoSuchAlgorithmException If the CRAM hash algorithm<a name="line.58"></a>
<span class="sourceLineNo">059</span>     *      cannot be instantiated by the Java runtime system.<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * @exception InvalidKeyException If the CRAM hash algorithm<a name="line.60"></a>
<span class="sourceLineNo">061</span>     *      failed to use the given password.<a name="line.61"></a>
<span class="sourceLineNo">062</span>     * @exception InvalidKeySpecException If the CRAM hash algorithm<a name="line.62"></a>
<span class="sourceLineNo">063</span>     *      failed to use the given password.<a name="line.63"></a>
<span class="sourceLineNo">064</span>     ***/<a name="line.64"></a>
<span class="sourceLineNo">065</span>    public boolean auth(AUTH_METHOD method,<a name="line.65"></a>
<span class="sourceLineNo">066</span>                        String username, String password)<a name="line.66"></a>
<span class="sourceLineNo">067</span>                        throws IOException, NoSuchAlgorithmException,<a name="line.67"></a>
<span class="sourceLineNo">068</span>                        InvalidKeyException, InvalidKeySpecException<a name="line.68"></a>
<span class="sourceLineNo">069</span>    {<a name="line.69"></a>
<span class="sourceLineNo">070</span>        if (sendCommand(POP3Command.AUTH, method.getAuthName())<a name="line.70"></a>
<span class="sourceLineNo">071</span>        != POP3Reply.OK_INT) {<a name="line.71"></a>
<span class="sourceLineNo">072</span>            return false;<a name="line.72"></a>
<span class="sourceLineNo">073</span>        }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>        switch(method) {<a name="line.75"></a>
<span class="sourceLineNo">076</span>            case PLAIN:<a name="line.76"></a>
<span class="sourceLineNo">077</span>                // the server sends an empty response ("+ "), so we don't have to read it.<a name="line.77"></a>
<span class="sourceLineNo">078</span>                return sendCommand(<a name="line.78"></a>
<span class="sourceLineNo">079</span>                    new String(<a name="line.79"></a>
<span class="sourceLineNo">080</span>                        Base64.encodeBase64(("\000" + username + "\000" + password).getBytes(getCharsetName())),<a name="line.80"></a>
<span class="sourceLineNo">081</span>                        getCharsetName()) // Java 1.6 can use getCharset()<a name="line.81"></a>
<span class="sourceLineNo">082</span>                    ) == POP3Reply.OK;<a name="line.82"></a>
<span class="sourceLineNo">083</span>            case CRAM_MD5:<a name="line.83"></a>
<span class="sourceLineNo">084</span>                // get the CRAM challenge<a name="line.84"></a>
<span class="sourceLineNo">085</span>                byte[] serverChallenge = Base64.decodeBase64(getReplyString().substring(2).trim());<a name="line.85"></a>
<span class="sourceLineNo">086</span>                // get the Mac instance<a name="line.86"></a>
<span class="sourceLineNo">087</span>                Mac hmac_md5 = Mac.getInstance("HmacMD5");<a name="line.87"></a>
<span class="sourceLineNo">088</span>                hmac_md5.init(new SecretKeySpec(password.getBytes(getCharsetName()), "HmacMD5")); // Java 1.6 can use getCharset()<a name="line.88"></a>
<span class="sourceLineNo">089</span>                // compute the result:<a name="line.89"></a>
<span class="sourceLineNo">090</span>                byte[] hmacResult = _convertToHexString(hmac_md5.doFinal(serverChallenge)).getBytes(getCharsetName()); // Java 1.6 can use getCharset()<a name="line.90"></a>
<span class="sourceLineNo">091</span>                // join the byte arrays to form the reply<a name="line.91"></a>
<span class="sourceLineNo">092</span>                byte[] usernameBytes = username.getBytes(getCharsetName()); // Java 1.6 can use getCharset()<a name="line.92"></a>
<span class="sourceLineNo">093</span>                byte[] toEncode = new byte[usernameBytes.length + 1 /* the space */ + hmacResult.length];<a name="line.93"></a>
<span class="sourceLineNo">094</span>                System.arraycopy(usernameBytes, 0, toEncode, 0, usernameBytes.length);<a name="line.94"></a>
<span class="sourceLineNo">095</span>                toEncode[usernameBytes.length] = ' ';<a name="line.95"></a>
<span class="sourceLineNo">096</span>                System.arraycopy(hmacResult, 0, toEncode, usernameBytes.length + 1, hmacResult.length);<a name="line.96"></a>
<span class="sourceLineNo">097</span>                // send the reply and read the server code:<a name="line.97"></a>
<span class="sourceLineNo">098</span>                return sendCommand(Base64.encodeBase64StringUnChunked(toEncode)) == POP3Reply.OK;<a name="line.98"></a>
<span class="sourceLineNo">099</span>            default:<a name="line.99"></a>
<span class="sourceLineNo">100</span>                return false;<a name="line.100"></a>
<span class="sourceLineNo">101</span>        }<a name="line.101"></a>
<span class="sourceLineNo">102</span>    }<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span>    /**<a name="line.104"></a>
<span class="sourceLineNo">105</span>     * Converts the given byte array to a String containing the hex values of the bytes.<a name="line.105"></a>
<span class="sourceLineNo">106</span>     * For example, the byte 'A' will be converted to '41', because this is the ASCII code<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * (and the byte value) of the capital letter 'A'.<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * @param a The byte array to convert.<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * @return The resulting String of hex codes.<a name="line.109"></a>
<span class="sourceLineNo">110</span>     */<a name="line.110"></a>
<span class="sourceLineNo">111</span>    private String _convertToHexString(byte[] a)<a name="line.111"></a>
<span class="sourceLineNo">112</span>    {<a name="line.112"></a>
<span class="sourceLineNo">113</span>        StringBuilder result = new StringBuilder(a.length*2);<a name="line.113"></a>
<span class="sourceLineNo">114</span>        for (byte element : a)<a name="line.114"></a>
<span class="sourceLineNo">115</span>        {<a name="line.115"></a>
<span class="sourceLineNo">116</span>            if ( (element &amp; 0x0FF) &lt;= 15 ) {<a name="line.116"></a>
<span class="sourceLineNo">117</span>                result.append("0");<a name="line.117"></a>
<span class="sourceLineNo">118</span>            }<a name="line.118"></a>
<span class="sourceLineNo">119</span>            result.append(Integer.toHexString(element &amp; 0x0FF));<a name="line.119"></a>
<span class="sourceLineNo">120</span>        }<a name="line.120"></a>
<span class="sourceLineNo">121</span>        return result.toString();<a name="line.121"></a>
<span class="sourceLineNo">122</span>    }<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span>    /**<a name="line.124"></a>
<span class="sourceLineNo">125</span>     * The enumeration of currently-supported authentication methods.<a name="line.125"></a>
<span class="sourceLineNo">126</span>     */<a name="line.126"></a>
<span class="sourceLineNo">127</span>    public static enum AUTH_METHOD<a name="line.127"></a>
<span class="sourceLineNo">128</span>    {<a name="line.128"></a>
<span class="sourceLineNo">129</span>        /** The standarised (RFC4616) PLAIN method, which sends the password unencrypted (insecure). */<a name="line.129"></a>
<span class="sourceLineNo">130</span>        PLAIN("PLAIN"),<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span>        /** The standarised (RFC2195) CRAM-MD5 method, which doesn't send the password (secure). */<a name="line.132"></a>
<span class="sourceLineNo">133</span>        CRAM_MD5("CRAM-MD5");<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span>        private final String methodName;<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span>        AUTH_METHOD(String methodName){<a name="line.137"></a>
<span class="sourceLineNo">138</span>            this.methodName = methodName;<a name="line.138"></a>
<span class="sourceLineNo">139</span>        }<a name="line.139"></a>
<span class="sourceLineNo">140</span>        /**<a name="line.140"></a>
<span class="sourceLineNo">141</span>         * Gets the name of the given authentication method suitable for the server.<a name="line.141"></a>
<span class="sourceLineNo">142</span>         * @return The name of the given authentication method suitable for the server.<a name="line.142"></a>
<span class="sourceLineNo">143</span>         */<a name="line.143"></a>
<span class="sourceLineNo">144</span>        public final String getAuthName()<a name="line.144"></a>
<span class="sourceLineNo">145</span>        {<a name="line.145"></a>
<span class="sourceLineNo">146</span>            return this.methodName;<a name="line.146"></a>
<span class="sourceLineNo">147</span>        }<a name="line.147"></a>
<span class="sourceLineNo">148</span>    }<a name="line.148"></a>
<span class="sourceLineNo">149</span>}<a name="line.149"></a>




























































</pre>
</div>
</body>
</html>
